Provision Apple Wallet (v1)

Initiates the provisioning of a card to Apple Wallet.

Query POST

Overview

Initiates the provisioning of a card to Apple Wallet.

POST (/internal/v1/cards/{token}:provision-apple-wallet)

Parameters

  • token (path) (required): Internal unique identifier for the card. See CardToken model.

Request Body

Responses

200 OK

The necessary details to complete the card provisioning.

400 Bad Request

Bad Request Response

500 Internal Server Error

Internal server error response

Architecture

5 properties

Provision Apple Wallet request body.

certificates array [string]
required

An array of Base64-encoded certificates provided by Apple. The first element must be the leaf certificate, followed by any subordinate CA certificates, in order.

deviceType string
required

Type of device where the digital wallet token will be provisioned.

Allowed values: MOBILE_PHONE TABLET WATCH
nonce string
required

A one-time-use, Base64-encoded nonce provided by Apple for security purposes.

nonceSignature string
required

A Base64-encoded signature of the nonce.

provisioningAppVersion string
required

Version of the application initiating the provisioning request.

Min length: 1
Max length: 50
3 properties

The necessary details to complete the card provisioning.

activationData string
required

data provided to the payment network as a cryptographic one-time password.

encryptedPassData string
required

Encrypted data containing the sensitive information needed to add a card to Apple Wallet.

ephemeralPublicKey string
required

Ephemeral public key used for the provisioning attempt.

7 properties

Bad Request Response

code string
Allowed values: urn:plmr:cards:connector:CARD_NOT_FOUND urn:plmr:cards:connector:CARD_ALREADY_TERMINATED urn:plmr:cards:connector:INVALID_CLIENT_PUBLIC_KEY urn:plmr:cards:connector:INVALID_CARD_STATE urn:plmr:cards:connector:IN_APP_PROVISION_NOT_ALLOWED urn:plmr:cards:connector:INVALID_CERTIFICATE_CHAIN
message string
requestId string
fieldErrors array [object]
7 properties

Internal server error response

code string
Allowed values: urn:plmr:cards:connector:CARD_NOT_FOUND urn:plmr:cards:connector:CARD_ALREADY_TERMINATED urn:plmr:cards:connector:INVALID_CLIENT_PUBLIC_KEY urn:plmr:cards:connector:INVALID_CARD_STATE urn:plmr:cards:connector:IN_APP_PROVISION_NOT_ALLOWED urn:plmr:cards:connector:INVALID_CERTIFICATE_CHAIN
message string
requestId string
fieldErrors array [object]